fix(create-neon): Render diagnostics to stderr in cargo build #1071

kjvalencik · 2024-09-23T15:29:28Z

Currently, create-neon uses --message-format=json which outputs diagnostics (e.g., compile errors) to stdout in JSON metadata. This makes it difficult to see compiler errors. For example, I have started with the out-of-the-box Neon app and changed the return type of hello to be JsNumber.

$ npm run build

> example@0.1.0 build
> npm run cargo-build -- --release


> example@0.1.0 cargo-build
> cargo build --message-format=json > cargo.log --release

   Compiling example v0.1.0 (/private/tmp/example)
error: could not compile `example` (lib) due to 2 previous errors

The error message does not show. If I change to --message-format=json-render-diagnostics, artifacts will still be sent to stdout, but compile errors will be rendered in human readable form on stderr.

$ npm run build

> example@0.1.0 build
> npm run cargo-build -- --release


> example@0.1.0 cargo-build
> cargo build --message-format=json-render-diagnostics > cargo.log --release

   Compiling example v0.1.0 (/private/tmp/example)
error[E0308]: mismatched types
   --> src/lib.rs:4:8
    |
4   |     Ok(cx.string("hello node"))
    |     -- ^^^^^^^^^^^^^^^^^^^^^^^ expected `Handle<'_, JsNumber>`, found `Handle<'_, JsString>`
    |     |
    |     arguments to this enum variant are incorrect
    |
    = note: expected struct `Handle<'_, neon::prelude::JsNumber>`
               found struct `Handle<'_, JsString>`

dherman

Thank you for explaining this -- I hadn't quite understood the difference between --json and --json-render-diagnostics. This is definitely better.

dherman · 2024-09-23T16:13:57Z

Published to the registry at create-neon@0.5.2! 🚀

kjvalencik requested a review from dherman September 23, 2024 15:29

fix(create-neon): Render diagnostics to stderr in cargo build

9d59b71

kjvalencik force-pushed the kv/render-diagnostics branch from 823c92c to 9d59b71 Compare September 23, 2024 15:35

dherman approved these changes Sep 23, 2024

View reviewed changes

kjvalencik merged commit e281554 into main Sep 23, 2024
9 checks passed

kjvalencik deleted the kv/render-diagnostics branch September 23, 2024 16:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(create-neon): Render diagnostics to stderr in cargo build #1071

fix(create-neon): Render diagnostics to stderr in cargo build #1071

kjvalencik commented Sep 23, 2024

dherman left a comment

dherman commented Sep 23, 2024

fix(create-neon): Render diagnostics to stderr in cargo build #1071

fix(create-neon): Render diagnostics to stderr in cargo build #1071

Conversation

kjvalencik commented Sep 23, 2024

dherman left a comment

Choose a reason for hiding this comment

dherman commented Sep 23, 2024